PortOne Server SDK for JVM/io.portone.sdk.server.identityverification

Package-level declarations

Types

Link copied to clipboard
@Serializable(with = CarrierSerializer::class)
sealed interface Carrier

통신사

Link copied to clipboard
@Serializable
data class ConfirmIdentityVerificationResponse(val identityVerification: VerifiedIdentityVerification)

본인인증 확인 성공 응답

Link copied to clipboard
@Serializable
@SerialName(value = "FAILED")
data class FailedIdentityVerification(val id: String, val channel: SelectedChannel? = null, val requestedCustomer: IdentityVerificationRequestedCustomer, val customData: String? = null, val requestedAt: @Serializable(with = InstantSerializer::class) Instant, val updatedAt: @Serializable(with = InstantSerializer::class) Instant, val statusChangedAt: @Serializable(with = InstantSerializer::class) Instant, val failure: IdentityVerificationFailure, val version: PortOneVersion) : IdentityVerification.Recognized

실패한 본인인증 내역

Link copied to clipboard
@Serializable
data class GetIdentityVerificationsResponse(val items: List<IdentityVerification>, val page: PageInfo)

본인인증 내역 다건 조회 성공 응답 정보

Link copied to clipboard
@Serializable(with = IdentityVerificationSerializer::class)
sealed interface IdentityVerification

본인인증 내역

Link copied to clipboard
class IdentityVerificationClient(apiSecret: String, apiBase: String = "https://api.portone.io", storeId: String? = null) : Closeable

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

Link copied to clipboard
@Serializable
data class IdentityVerificationFailure(val reason: String? = null, val pgCode: String? = null, val pgMessage: String? = null)

본인인증 실패 정보

Link copied to clipboard
@Serializable
data class IdentityVerificationFilterCustomerInput(val name: String? = null, val birthYear: String? = null, val birthMonth: String? = null, val birthDay: String? = null, val phoneNumber: String? = null, val gender: Gender? = null)

본인인증 다건 조회를 위한 고객 정보 입력 정보

Link copied to clipboard
@Serializable
data class IdentityVerificationFilterInput(val storeId: String? = null, val timeRangeField: IdentityVerificationTimeRangeField? = null, val from: @Serializable(with = InstantSerializer::class) Instant? = null, val until: @Serializable(with = InstantSerializer::class) Instant? = null, val identityVerificationId: String? = null, val identityVerificationTxId: String? = null, val isTest: Boolean? = null, val statuses: List<IdentityVerificationStatus>? = null, val pgTxId: String? = null, val pgMerchantId: String? = null, val pgProviders: List<PgProvider>? = null, val pgCompanies: List<PgCompany>? = null, val carriers: List<Carrier>? = null, val version: PortOneVersion? = null, val customer: IdentityVerificationFilterCustomerInput? = null)

본인인증 다건 조회를 위한 입력 정보

Link copied to clipboard
@Serializable(with = IdentityVerificationMethodSerializer::class)
sealed interface IdentityVerificationMethod

본인인증 방식

Link copied to clipboard
@Serializable(with = IdentityVerificationOperatorSerializer::class)
sealed interface IdentityVerificationOperator

본인인증 통신사

Link copied to clipboard
@Serializable
data class IdentityVerificationRequestedCustomer(val id: String? = null, val name: String? = null, val phoneNumber: String? = null, val birthYear: String? = null, val birthMonth: String? = null, val birthDay: String? = null)

요청 시 고객 정보

Link copied to clipboard
@Serializable(with = IdentityVerificationSortBySerializer::class)
sealed interface IdentityVerificationSortBy

본인인증 내역 정렬 기준

Link copied to clipboard
@Serializable
data class IdentityVerificationSortInput(val by: IdentityVerificationSortBy? = null, val order: SortOrder? = null)

본인인증 내역 다건 조회 시 정렬 조건

Link copied to clipboard
@Serializable(with = IdentityVerificationStatusSerializer::class)
sealed interface IdentityVerificationStatus

본인인증 상태

Link copied to clipboard
@Serializable(with = IdentityVerificationTimeRangeFieldSerializer::class)
sealed interface IdentityVerificationTimeRangeField

본인인증 다건 조회 시, 시각 범위를 적용할 필드

Link copied to clipboard
@Serializable
data class IdentityVerificationVerifiedCustomer(val id: String? = null, val name: String, val operator: IdentityVerificationOperator? = null, val phoneNumber: String? = null, val birthDate: String? = null, val gender: Gender? = null, val isForeigner: Boolean? = null, val ci: String? = null, val di: String? = null)

인증된 고객 정보

Link copied to clipboard
@Serializable
@SerialName(value = "READY")
data class ReadyIdentityVerification(val id: String, val channel: SelectedChannel? = null, val requestedCustomer: IdentityVerificationRequestedCustomer, val customData: String? = null, val requestedAt: @Serializable(with = InstantSerializer::class) Instant, val updatedAt: @Serializable(with = InstantSerializer::class) Instant, val statusChangedAt: @Serializable(with = InstantSerializer::class) Instant, val version: PortOneVersion) : IdentityVerification.Recognized

준비 상태의 본인인증 내역

Link copied to clipboard
@Serializable
data object ResendIdentityVerificationResponse

본인인증 요청 재전송 성공 응답

Link copied to clipboard
@Serializable
data class SendIdentityVerificationBodyCustomer(val id: String? = null, val name: String, val phoneNumber: String, val identityNumber: String? = null, val ipAddress: String)

본인인증 요청을 위한 고객 정보

Link copied to clipboard
@Serializable
data object SendIdentityVerificationResponse

본인인증 요청 전송 성공 응답

Link copied to clipboard
@Serializable
@SerialName(value = "VERIFIED")
data class VerifiedIdentityVerification(val id: String, val channel: SelectedChannel? = null, val verifiedCustomer: IdentityVerificationVerifiedCustomer, val customData: String? = null, val requestedAt: @Serializable(with = InstantSerializer::class) Instant, val updatedAt: @Serializable(with = InstantSerializer::class) Instant, val statusChangedAt: @Serializable(with = InstantSerializer::class) Instant, val verifiedAt: @Serializable(with = InstantSerializer::class) Instant, val pgTxId: String, val pgRawResponse: String, val version: PortOneVersion) : IdentityVerification.Recognized

완료된 본인인증 내역